Skip to content

feat: rework readme#1703

Merged
jessicaschilling merged 27 commits intomasterfrom
feat/readme-tweaks
Oct 22, 2020
Merged

feat: rework readme#1703
jessicaschilling merged 27 commits intomasterfrom
feat/readme-tweaks

Conversation

@jessicaschilling
Copy link
Contributor

@jessicaschilling jessicaschilling commented Oct 21, 2020

Closes #1670.

  • Rewrites README overall, primarily focusing on better explanation of features
  • Updates throughout for outdatedness
  • New screenshots
  • Moved release checklist into DEVELOPER-NOTES.md to avoid wall of scary text
  • Copy/clarity edits, etc etc

Note: Once this is approved/merged, I'll add some highlights (primarily features list) to https://docs.ipfs.io/install/ipfs-desktop/ in a separate PR in the docs repo.

@jessicaschilling
Copy link
Contributor Author

@lidel - do you mind a review? Thank you!

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! This PR makes README much more useful.

I noticed some things were outdated, see small suggestions/fixes/clarifications inline.

jessicaschilling and others added 6 commits October 22, 2020 12:31
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README needs more details on Features

2 participants